home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Vk / VkMsgWindow.z / VkMsgWindow
Encoding:
Text File  |  1998-10-20  |  9.1 KB  |  265 lines
  1.  
  2.  
  3.  
  4. VVVVkkkkMMMMssssggggWWWWiiiinnnnddddoooowwww((((3333xxxx))))                                                VVVVkkkkMMMMssssggggWWWWiiiinnnnddddoooowwww((((3333xxxx))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      VkMsgWindow - Base class for all top-level messaging windows with menus
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkWindow : VkSimpleWindow : VkComponent : VkCallabckObject
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <Vk/VkMsgWindow.h>
  16.  
  17. PPPPUUUUBBBBLLLLIIIICCCC PPPPRRRROOOOTTTTOOOOCCCCOOOOLLLL SSSSUUUUMMMMMMMMAAAARRRRYYYY
  18.    CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr////DDDDeeeessssttttrrrruuuuccccttttoooorrrr
  19.            VkMsgWindow(const char* name);
  20.  
  21.            virtual void ~VkMsgWindow(void);
  22.  
  23.  
  24.    MMMMeeeessssssssaaaaggggeeee FFFFaaaacccciiiilllliiiittttyyyy AAAAcccccccceeeessssssss
  25.            VkMsgClient* messageClient(void);
  26.  
  27.            void updatePatterns(void);
  28.  
  29.            VkMsgPattern addAction(char* name,
  30.                                   VkMsgClientAction proc,
  31.                                   void* client_data,
  32.                                   VkMsgActionType type,
  33.                                   Boolean deleteMessage = True);
  34.  
  35.            VkMsgPattern createAction(char* name,
  36.                                      VkMsgClientAction proc,
  37.                                      void* client_data,
  38.                                      VkMsgActionType type,
  39.                                      Boolean deleteMessage = True);
  40.  
  41.            void removeAction(VkMsgPattern pat);
  42.  
  43.            void addTranslation(char* name,
  44.                                VkMsgClientAction proc,
  45.                                void* client_data,
  46.                                Boolean deleteMessage = True);
  47.  
  48.            void removeTranslation(char* name);
  49.  
  50.            VkMsgStatus registerPattern(VkMsgPattern pat);
  51.  
  52.            VkMsgStatus unregisterPattern(VkMsgPattern pat);
  53.  
  54.            VkMsgStatus destroyPattern(VkMsgPattern pat);
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. VVVVkkkkMMMMssssggggWWWWiiiinnnnddddoooowwww((((3333xxxx))))                                                VVVVkkkkMMMMssssggggWWWWiiiinnnnddddoooowwww((((3333xxxx))))
  71.  
  72.  
  73.  
  74. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  75.      VkMsgWindow is a subclass of VkWindow which creates a VkMsgClient object.
  76.      Windows which handle messages (e.g. top-level application windows) should
  77.      be subclasses of VkMsgWindow.  There are convenience methods for
  78.      accessing VkMsgClient methods.  VkMsgWindow also provides support for
  79.      raise and iconify operations.
  80.  
  81.  
  82. DDDDEEEERRRRIIIIVVVVIIIINNNNGGGG SSSSUUUUBBBBCCCCLLLLAAAASSSSSSSSEEEESSSS
  83.      The same guidelines for deriving from VkWindow apply to VkMsgWindow
  84.      subclasses.
  85.  
  86.  
  87. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  88.    VVVVkkkkMMMMssssggggWWWWiiiinnnnddddoooowwww(((())))
  89.            VkMsgWindow(const char* name);
  90.  
  91.            virtual void ~VkMsgWindow(void);
  92.  
  93.  
  94.           Same as VkWindow constructor.
  95.  
  96.    mmmmeeeessssssssaaaaggggeeeeCCCClllliiiieeeennnntttt(((())))
  97.            VkMsgClient* messageClient(void);
  98.  
  99.  
  100.           Returns a pointer to the VkMsgClient object for access to message
  101.           facility functionality.  See the VkMsgClient man page for more
  102.           details.
  103.  
  104.    MMMMeeeessssssssaaaaggggeeee RRRRoooouuuuttttiiiinnnneeeessss
  105.            void updatePatterns(void);
  106.  
  107.            VkMsgPattern addAction(char* name,
  108.                                   VkMsgClientAction proc,
  109.                                   void* client_data,
  110.                                   VkMsgActionType type,
  111.                                   Boolean deleteMessage = True);
  112.  
  113.            VkMsgPattern createAction(char* name,
  114.                                      VkMsgClientAction proc,
  115.                                      void* client_data,
  116.                                      VkMsgActionType type,
  117.                                      Boolean deleteMessage = True);
  118.  
  119.            void removeAction(VkMsgPattern pat);
  120.  
  121.            void addTranslation(char* name,
  122.                                VkMsgClientAction proc,
  123.                                void* client_data,
  124.                                Boolean deleteMessage = True);
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. VVVVkkkkMMMMssssggggWWWWiiiinnnnddddoooowwww((((3333xxxx))))                                                VVVVkkkkMMMMssssggggWWWWiiiinnnnddddoooowwww((((3333xxxx))))
  137.  
  138.  
  139.  
  140.            void removeTranslation(char* name);
  141.  
  142.            VkMsgStatus registerPattern(VkMsgPattern pat);
  143.  
  144.            VkMsgStatus unregisterPattern(VkMsgPattern pat);
  145.  
  146.            VkMsgStatus destroyPattern(VkMsgPattern pat);
  147.  
  148.  
  149.           Convenience routines for accessing VkMsgClient methods.  See the
  150.           VkMsgClient man page for more details.
  151.  
  152.           Be sure to add your message actions with addAction before entering
  153.           any Xt event loop.  Otherwise, messages may be received before the
  154.           action is registered, and they will not be processed as expected.
  155.           The Xt event loop is entered when you call VkApp::run, or when you
  156.           post a ViewKit dialog and a short, secondary event loop is entered.
  157.  
  158. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  159.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkWWWWiiiinnnnddddoooowwww
  160.           className(),  setUpInterface(),  VkWindow(),  ~VkWindow(),
  161.           setMenuBar(),  setMenuBar(), addMenuPane(),  addMenuPane(),
  162.           addRadioMenuPane(),  addRadioMenuPane(),  menu(),
  163.  
  164.  
  165.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkSSSSiiiimmmmpppplllleeeeWWWWiiiinnnnddddoooowwww
  166.           afterRealizeHook(), show(), hide(), stateChanged(),
  167.           handleWmDeleteMessage(), handleRawEvent(), addView(), removeView(),
  168.           open(), raise(), lower(), iconize(), iconify(), getTitle(),
  169.           setTitle(), setIconName(), setClassHint(), iconic(), visible(),
  170.           mainWindowWidget(), viewWidget(), _iconState, _visibleState,
  171.           _stackingState, _mainWindowWidget,
  172.  
  173.  
  174.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt
  175.           installDestroyHandler(), removeDestroyHandler(), widgetDestroyed(),
  176.           setDefaultResources(), getResources(), callCallbacks(),
  177.           VkComponent(), manage(), unmanage(), baseWidget(), okToQuit(),
  178.           _name, _baseWidget, _w, deleteCallback
  179.  
  180.  
  181.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm VVVVkkkkCCCCaaaallllllllbbbbaaaacccckkkkOOOObbbbjjjjeeeecccctttt
  182.           callCallbacks(), addCallback(), addCallback(), removeCallback(),
  183.           removeCallback(), removeAllCallbacks(), removeAllCallbacks()
  184.  
  185.  
  186. CCCCLLLLAAAASSSSSSSSEEEESSSS UUUUSSSSEEEEDDDD BBBBYYYY TTTTHHHHIIIISSSS CCCCLLLLAAAASSSSSSSS
  187.      VkMsgClient, VkMsgService
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. VVVVkkkkMMMMssssggggWWWWiiiinnnnddddoooowwww((((3333xxxx))))                                                VVVVkkkkMMMMssssggggWWWWiiiinnnnddddoooowwww((((3333xxxx))))
  203.  
  204.  
  205.  
  206. SEE ALSO
  207.      VkWindow, VkSimpleWindow, VkComponent, VkMsgClient, VkMsgService
  208.      _V_i_e_w_K_i_t _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e
  209.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m, DEC Press, Bob Sheifler and Jim Gettys
  210.      _T_h_e _X _W_i_n_d_o_w _S_y_s_t_e_m _T_o_o_l_k_i_t, DEC Press, Paul Asente and Ralph Swick
  211.      _T_h_e _O_S_F/_M_o_t_i_f _P_r_o_g_r_a_m_m_e_r_s _R_e_f_e_r_e_n_c_e, Prentice Hall, OSF
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.